home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / statsb1.zip / STATS.DOC < prev    next >
Text File  |  1992-09-23  |  6KB  |  159 lines
  1. File Transfer Statistics Door For PCBoard
  2.  
  3.      STATS is a door that will compile a user's file transfer statistics and
  4.      display them.  It will display completed uploads and downloads, aborted
  5.      uploads and downloads as well as rejected uploads.  Stats will also allow
  6.      the sysop to select a different user to compile and display transfer
  7.      statistics.
  8.  
  9. History
  10.  
  11.      Ver 0.1b - Initial coding and release
  12.  
  13. Setup
  14.  
  15.    1. Create a config file that contains the following information
  16.       1 - Complete path and file name to PCBOARD.SYS
  17.       2 - The name of your BBS
  18.       3 - Sysop's first name
  19.       4 - Sysop's last name
  20.       5 - Complete path and file name to callers log
  21.       6 - Complete path and file name to DOWNLOAD.TXT
  22.       7 - Complete path and file name to menu screen
  23.       8 - Complete path and file name to welcome screen
  24.       9 - Complete path and file name to goodbye screen
  25.      10 - Security level to allow selection of a different user
  26.  
  27.    2. Create a file to execute the Preview Door
  28.  
  29.       @ECHO OFF
  30.       CD D:\PCB1\DOORS\STATS
  31.       STATS STATS.CFG
  32.  
  33.    3. Add the Stats Door entry to your doors list file
  34.  
  35. Operation
  36.  
  37. NOTE: The following functions are available when a user is logged in STATS
  38.  
  39.       F3 - Toggle Printer On/Off
  40.       F4 - Toggle Sysop Page Status
  41.       F5 - Shell to DOS
  42.       F7 - Toggle Caller Alarm
  43.       F8 - Dump User Back To BBS
  44.       F9 - Toggle Display On/Off
  45.       F10 - Initiate Sysop Chat.  When in chat mode, ESC will terminate chat
  46.       ALT N - Sets Sysop On Next Flag
  47.       ALT X - Sets Exit To DOS flag
  48.       Up Arrow - Increase User Time
  49.       Dn Arrow - Decrease User Time
  50.       Rt Arrow - Increase User Security Level
  51.       Lt Arrow - Decrease User Security Level
  52.  
  53. Features available in non-registered version
  54.  
  55.       Display completed uploads and downloads as well as totals for completed
  56.       uploads/downloads, aborted uploads/downloads, and rejected uploads
  57.  
  58. Features available in registered version
  59.  
  60.       Enable Sysop control to select different user in door as well as allow
  61.       sysop to set up co-sysop access to door.  Enable aborted downloads,
  62.       aborted uploads and rejected uploads menu options.
  63.  
  64. There are eight options available once the user is in STATS.
  65.  
  66.       Option 1 - Display completed uploads
  67.      *Option 2 - Display aborted uploads
  68.      *Option 3 - Display rejected uploads
  69.       Option 4 - Display completed downloads
  70.      *Option 5 - Display aborted downloads
  71.      *Option 6 - Display who downloaded a paticular file
  72.      *Option 7 - Select new user for display - Available only to sysop or
  73.                  co-sysop
  74.       Option 8 - Return to BBS
  75.  
  76. Items with an * are available only in the registered version.  When the sysop
  77. is logged on, all menu functions are available so (s)he can properly evaluate
  78. the door.
  79.  
  80. Stats supports a custom menu, welcome, and logoff screen both ansi and non-ansi
  81. versions.  To create an ansi version, add a G to the file name specified in the
  82. config file.  Stats will look for the file name specified.  If it finds it,
  83. then it will look for the ansi version.  When creating these files, I recommend
  84. using The Draw, and when saving them, use the block save function.
  85.  
  86. ====[  This is important  ]====================================================
  87.  
  88.     When saving your menu screen, use the block save command and set Video
  89.     Preperation to None.  You are also limited to 9 lines for your menu.  When
  90.     creating the menu, keep in mind that each function is selected by it's
  91.     apropriate number.  Sample menu and welcome screens are included in this
  92.     archive.
  93.  
  94. ===============================================================================
  95.  
  96.     The door supports standard comm ports 1 - 4
  97.  
  98.       Port 3 on 3E8/IRQ4 and Port 4 on 2E8/IRQ3
  99.  
  100.       Non-standard comm port interrupts are also supported.  To utilize IRQ 5
  101.       your command line to call the door should look like this:
  102.  
  103.       STATS STATS.CFG /5
  104.  
  105. Warranty
  106.  
  107.     This product is provided "as is" without warranty of any kind. The entire
  108.     risk as to the results and  performance of the program is assumed by you.
  109.     Futhermore, the  author does  not warrant, guarantee, or  make any  other
  110.     representations regarding  the use of,  or the  results of the use of the
  111.     program,  and you  rely on the  program and  results  solely at  your own
  112.     risk.  The author  cannot and  will not accept  responsibility for system
  113.     damage, loss of profit, or any other special, consequential or incidental
  114.     damages  resulting  from  the  use  or  inability  to  use this  product.
  115.  
  116. Copyright
  117.  
  118.     Stats Copyright (c) 1992 by  Chris Gifford  is being distributed as
  119.     Shareware. Under this concept you may use the  SHAREWARE  (unregistered)
  120.     version for a reasonable period of  time for evaluation  after which you
  121.     must either register your copy or discontinue  usage.  This time period is
  122.     set for 60 days.
  123.  
  124. Registration:
  125.  
  126.     Registration gets you support via tha Antares Sector BBS (801) 544-7613.
  127.     A registration fee of $15 is required.  Please send all registrations to:
  128.  
  129.       Chris Gifford
  130.       189 S. Main, #40
  131.       Layton, UT  84041
  132.  
  133.     Please include exactly how you want your name to appear when the door first
  134.     opens.  You are limited to 35 characters or less.  Please include your BBS
  135.     number so I can upload the latest version of STATS and the key to remove
  136.     to opening delay.
  137.  
  138. Support
  139.  
  140.     I believe in supporting any software that I develop, whether the user has
  141.     registered the software or not.  Support for STATS can be obtained through
  142.     The Antares Sector (801) 544-7613 via the support conference, USR HST D/S
  143.  
  144.  
  145.     I also monitor the following conferences on RIME (PCRelay):
  146.        BBSDoors, Common, Graphics
  147.  
  148. Distribution
  149.  
  150.    You  are encouraged to distribute STATS provided that all files
  151.    contained in the archive are distributed in their original and
  152.    unmodified state.
  153.  
  154.    If you wish to be a beta tester then leave me a comment on the Antares
  155.    Sector BBS.  Being a Beta Tester gets you a free version of the non-beta
  156.    release of STATS.  To be a beta tester, I'll need the name and number of
  157.    the BBS that Preview will be operating on and feed back atleast once a week,
  158.    even if it's to say that no errors have been encountered.
  159.